<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>v_voip_decap: xdecap_intr.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">v_voip_decap
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xdecap__intr_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xdecap_intr.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file contains interrupt related functions for Xilinx VoIP Decapsulator core. </p>
<p>Please see <a class="el" href="xdecap_8h.html" title="This is the main header file for VoIP Decapsulator core. ">xdecap.h</a> for more details of the driver.</p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who    Date     Changes
<hr/>

1.00   mmo   02/12/16 Initial release.</pre><pre></pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a1d8627c3a0bd6fdb2e388b69289e5490"><td class="memItemLeft" align="right" valign="top">typedef struct ChArray&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdecap__intr_8c.html#a1d8627c3a0bd6fdb2e388b69289e5490">XDecapChIntr</a></td></tr>
<tr class="memdesc:a1d8627c3a0bd6fdb2e388b69289e5490"><td class="mdescLeft">&#160;</td><td class="mdescRight">This typedef contains Current Interrupt Information.  <a href="#a1d8627c3a0bd6fdb2e388b69289e5490">More...</a><br /></td></tr>
<tr class="separator:a1d8627c3a0bd6fdb2e388b69289e5490"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a4b4414c56b430d8b8f5f42ebf7efa305"><td class="memItemLeft" align="right" valign="top"><a class="el" href="xdecap__intr_8c.html#a1d8627c3a0bd6fdb2e388b69289e5490">XDecapChIntr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdecap__intr_8c.html#a4b4414c56b430d8b8f5f42ebf7efa305">XDecap_ChIntr</a> (<a class="el" href="struct_x_decap.html">XDecap</a> *InstancePtr)</td></tr>
<tr class="memdesc:a4b4414c56b430d8b8f5f42ebf7efa305"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function scans through the Interrupt General Register to detect &amp; store the information of the interrupted channel.  <a href="#a4b4414c56b430d8b8f5f42ebf7efa305">More...</a><br /></td></tr>
<tr class="separator:a4b4414c56b430d8b8f5f42ebf7efa305"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adff14306a49cad1500cfb3c8f2d282c2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdecap__intr_8c.html#adff14306a49cad1500cfb3c8f2d282c2">XDecap_IntrHandler</a> (void *InstancePtr)</td></tr>
<tr class="memdesc:adff14306a49cad1500cfb3c8f2d282c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is the interrupt handler for the VoIP Decapsulator driver.  <a href="#adff14306a49cad1500cfb3c8f2d282c2">More...</a><br /></td></tr>
<tr class="separator:adff14306a49cad1500cfb3c8f2d282c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4a12599c9953fbf0e86bd61f5cb00a2"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xdecap__intr_8c.html#ac4a12599c9953fbf0e86bd61f5cb00a2">XDecap_SetCallback</a> (<a class="el" href="struct_x_decap.html">XDecap</a> *InstancePtr, <a class="el" href="xdecap_8h.html#a808b308838800d9069f4f3ccb028da6b">XDecap_HandlerType</a> HandlerType, void *CallbackFunc, void *CallbackRef)</td></tr>
<tr class="memdesc:ac4a12599c9953fbf0e86bd61f5cb00a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function installs an asynchronous callback function for the given HandlerType:  <a href="#ac4a12599c9953fbf0e86bd61f5cb00a2">More...</a><br /></td></tr>
<tr class="separator:ac4a12599c9953fbf0e86bd61f5cb00a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="a1d8627c3a0bd6fdb2e388b69289e5490"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1d8627c3a0bd6fdb2e388b69289e5490">&#9670;&nbsp;</a></span>XDecapChIntr</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef struct ChArray  <a class="el" href="xdecap__intr_8c.html#a1d8627c3a0bd6fdb2e388b69289e5490">XDecapChIntr</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This typedef contains Current Interrupt Information. </p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a4b4414c56b430d8b8f5f42ebf7efa305"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b4414c56b430d8b8f5f42ebf7efa305">&#9670;&nbsp;</a></span>XDecap_ChIntr()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="xdecap__intr_8c.html#a1d8627c3a0bd6fdb2e388b69289e5490">XDecapChIntr</a> XDecap_ChIntr </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_decap.html">XDecap</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function scans through the Interrupt General Register to detect &amp; store the information of the interrupted channel. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_decap.html" title="The XDecap driver instance data. ">XDecap</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

</div>
</div>
<a id="adff14306a49cad1500cfb3c8f2d282c2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adff14306a49cad1500cfb3c8f2d282c2">&#9670;&nbsp;</a></span>XDecap_IntrHandler()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XDecap_IntrHandler </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is the interrupt handler for the VoIP Decapsulator driver. </p>
<p>This handler reads the pending interrupt from VoIP Decapsulator, determines the source of the interrupts, clears the interrupts and calls callbacks accordingly.</p>
<p>The application is responsible for connecting this function to the interrupt system. Application beyond this driver is also responsible for providing callbacks to handle interrupts and installing the callbacks using <a class="el" href="xdecap__intr_8c.html#ac4a12599c9953fbf0e86bd61f5cb00a2" title="This function installs an asynchronous callback function for the given HandlerType: ...">XDecap_SetCallback()</a> during initialization phase. An example delivered with this driver demonstrates how this could be done.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_decap.html" title="The XDecap driver instance data. ">XDecap</a> instance that just interrupted.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_decap.html#a1fb6969b320fcfe70fb734325c3caca8">XDecap::IsReady</a>.</p>

</div>
</div>
<a id="ac4a12599c9953fbf0e86bd61f5cb00a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4a12599c9953fbf0e86bd61f5cb00a2">&#9670;&nbsp;</a></span>XDecap_SetCallback()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XDecap_SetCallback </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_decap.html">XDecap</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="xdecap_8h.html#a808b308838800d9069f4f3ccb028da6b">XDecap_HandlerType</a>&#160;</td>
          <td class="paramname"><em>HandlerType</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>CallbackFunc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>CallbackRef</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function installs an asynchronous callback function for the given HandlerType: </p>
<pre>
HandlerType                 Callback Function Type
-------------------------   -----------------------------------------------
</pre><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the VoIP Decapsulator core instance. </td></tr>
    <tr><td class="paramname">HandlerType</td><td>specifies the type of handler. </td></tr>
    <tr><td class="paramname">CallbackFunc</td><td>is the address of the callback function. </td></tr>
    <tr><td class="paramname">CallbackRef</td><td>is a user data item that will be passed to the callback function when it is invoked.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if callback function installed successfully.</li>
<li>XST_INVALID_PARAM when HandlerType is invalid.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Invoking this function for a handler that already has been installed replaces it with the new handler. </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
